<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gmime: GMime 3.0 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GMime 3.0 Reference Manual">
<link rel="up" href="core.html" title="Part III. GMime Core Reference">
<link rel="prev" href="core.html" title="Part III. GMime Core Reference">
<link rel="next" href="gmime-gmime-charset.html" title="gmime-charset">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gmime-gmime.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="core.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gmime-gmime-charset.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gmime-gmime"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gmime-gmime.top_of_page"></a>gmime</span></h2>
<p>gmime — Initialization, shutdown and version-check routines</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gmime-gmime.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#GMIME-CHECK-VERSION:CAPS" title="GMIME_CHECK_VERSION()">GMIME_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()">g_mime_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#g-mime-shutdown" title="g_mime_shutdown ()">g_mime_shutdown</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="gmime-gmime.html#g-mime-check-version" title="g_mime_check_version ()">g_mime_check_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-gmime.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-MAJOR-VERSION:CAPS" title="GMIME_MAJOR_VERSION">GMIME_MAJOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-MICRO-VERSION:CAPS" title="GMIME_MICRO_VERSION">GMIME_MICRO_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-MINOR-VERSION:CAPS" title="GMIME_MINOR_VERSION">GMIME_MINOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-BINARY-AGE:CAPS" title="GMIME_BINARY_AGE">GMIME_BINARY_AGE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="gmime-gmime.html#GMIME-INTERFACE-AGE:CAPS" title="GMIME_INTERFACE_AGE">GMIME_INTERFACE_AGE</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-major-version" title="gmime_major_version">gmime_major_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-minor-version" title="gmime_minor_version">gmime_minor_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-micro-version" title="gmime_micro_version">gmime_micro_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-binary-age" title="gmime_binary_age">gmime_binary_age</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="gmime-gmime.html#gmime-interface-age" title="gmime_interface_age">gmime_interface_age</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gmime-gmime.description"></a><h2>Description</h2>
<p>Initialization, shutdown, and version-check functions.</p>
</div>
<div class="refsect1">
<a name="gmime-gmime.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GMIME-CHECK-VERSION:CAPS"></a><h3>GMIME_CHECK_VERSION()</h3>
<pre class="programlisting">#define             GMIME_CHECK_VERSION(major,minor,micro)</pre>
<p>Check whether a GMime version equal to or greater than
<em class="parameter"><code>major</code></em>
.<em class="parameter"><code>minor</code></em>
.<em class="parameter"><code>micro</code></em>
 is present.</p>
<div class="refsect3">
<a name="GMIME-CHECK-VERSION.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>Minimum major version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>Minimum minor version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>Minimum micro version</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-init"></a><h3>g_mime_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initializes GMime.</p>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-shutdown"></a><h3>g_mime_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
g_mime_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Frees internally allocated tables created in <a class="link" href="gmime-gmime.html#g-mime-init" title="g_mime_init ()"><code class="function">g_mime_init()</code></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="g-mime-check-version"></a><h3>g_mime_check_version ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
g_mime_check_version (<em class="parameter"><code><span class="type">guint</span> major</code></em>,
                      <em class="parameter"><code><span class="type">guint</span> minor</code></em>,
                      <em class="parameter"><code><span class="type">guint</span> micro</code></em>);</pre>
<p>Checks that the GMime library version meets the requirements of the
required version.</p>
<div class="refsect3">
<a name="g-mime-check-version.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>Minimum major version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>Minimum minor version</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>Minimum micro version</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="g-mime-check-version.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the requirement is met or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="gmime-gmime.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GMIME-MAJOR-VERSION:CAPS"></a><h3>GMIME_MAJOR_VERSION</h3>
<pre class="programlisting">#define GMIME_MAJOR_VERSION (3U)
</pre>
<p>GMime's major version.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-MICRO-VERSION:CAPS"></a><h3>GMIME_MICRO_VERSION</h3>
<pre class="programlisting">#define GMIME_MICRO_VERSION (7U)
</pre>
<p>GMime's micro version.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-MINOR-VERSION:CAPS"></a><h3>GMIME_MINOR_VERSION</h3>
<pre class="programlisting">#define GMIME_MINOR_VERSION (2U)
</pre>
<p>GMime's minor version.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-BINARY-AGE:CAPS"></a><h3>GMIME_BINARY_AGE</h3>
<pre class="programlisting">#define GMIME_BINARY_AGE    (207U)
</pre>
<p>GMime's binary age.</p>
</div>
<hr>
<div class="refsect2">
<a name="GMIME-INTERFACE-AGE:CAPS"></a><h3>GMIME_INTERFACE_AGE</h3>
<pre class="programlisting">#define GMIME_INTERFACE_AGE (1U)
</pre>
<p>GMime's interface age.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-major-version"></a><h3>gmime_major_version</h3>
<pre class="programlisting">extern const guint gmime_major_version;
</pre>
<p>GMime's major version.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-minor-version"></a><h3>gmime_minor_version</h3>
<pre class="programlisting">extern const guint gmime_minor_version;
</pre>
<p>GMime's minor version.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-micro-version"></a><h3>gmime_micro_version</h3>
<pre class="programlisting">extern const guint gmime_micro_version;
</pre>
<p>GMime's micro version.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-binary-age"></a><h3>gmime_binary_age</h3>
<pre class="programlisting">extern const guint gmime_binary_age;
</pre>
<p>GMime's binary age.</p>
</div>
<hr>
<div class="refsect2">
<a name="gmime-interface-age"></a><h3>gmime_interface_age</h3>
<pre class="programlisting">extern const guint gmime_interface_age;
</pre>
<p>GMime's interface age.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>